You are currently viewing the Homey Apps SDK v2 documentation. New apps should use Homey Apps SDK v3 ››
Library
L
Getting Started
L
App Development Guidelines
L
SDK Changelog
L
App Manifest
L
App Settings
L
App Store
L
Drivers
L
Capabilities
L
Pairing
L
System Views
L
Devices List
L
Add Devices
L
OAuth2 Login
L
Credentials Login
L
Pincode
L
Loading
L
Done
L
Custom Views
L
Discovery
L
User Interface
L
Settings
L
Maintenance Actions
L
Images
L
Energy
L
Flow
L
State
L
Tokens
L
Image Tokens
L
Arguments
L
Devices
L
Homey Compose
L
Icons
L
Images
L
Internationalization
L
LED Ring
L
Permissions
L
Signals
L
Creating a Signal
L
Prontohex
L
Radio Configuration
L
Web API
L
Webhooks
L
Webviews
L
Z-Wave
L
Zigbee
L
Clusters Reference
Modules
M
Homey
F
__
E
cpuwarn
E
memwarn
E
unload
Classes
C
Api
F
delete
F
get
F
post
F
put
F
register
F
unregister
C
ApiApp
F
delete
F
get
F
getInstalled
F
getVersion
F
post
F
put
F
register
F
unregister
C
App
F
error
F
log
F
onInit
C
BleAdvertisement
F
connect
C
BleCharacteristic
F
discoverDescriptors
F
read
F
write
C
BleDescriptor
F
readValue
F
writeValue
C
BlePeripheral
F
assertConnected
F
connect
F
disconnect
F
discoverAllServicesAndCharacteristics
F
discoverServices
F
getService
F
read
F
updateRssi
F
write
C
BleService
F
discoverCharacteristics
F
discoverIncludedServices
F
getCharacteristic
F
read
F
write
C
CloudOAuth2Callback
F
generate
E
code
E
url
C
CloudWebhook
F
register
F
unregister
E
message
C
CronTask
E
run
C
Device
F
addCapability
F
getAvailable
F
getCapabilities
F
getCapabilityOptions
F
getCapabilityValue
F
getClass
F
getData
F
getDriver
F
getEnergy
F
getName
F
getSetting
F
getSettings
F
getState
F
getStore
F
getStoreKeys
F
getStoreValue
F
hasCapability
F
onAdded
F
onDeleted
F
onDiscoveryAddressChanged
F
onDiscoveryAvailable
F
onDiscoveryLastSeenChanged
F
onDiscoveryResult
F
onInit
F
onRenamed
F
onSettings
F
ready
F
registerCapabilityListener
F
registerMultipleCapabilityListener
F
removeCapability
F
setAlbumArtImage
F
setAvailable
F
setCameraImage
F
setCapabilityOptions
F
setCapabilityValue
F
setClass
F
setEnergy
F
setSettings
F
setStoreValue
F
setUnavailable
F
setWarning
F
triggerCapabilityListener
F
unsetStoreValue
F
unsetWarning
C
DiscoveryResult
E
addressChanged
E
lastSeenChanged
C
DiscoveryResultMAC
E
addressChanged
E
lastSeenChanged
C
DiscoveryResultMDNSSD
E
addressChanged
E
lastSeenChanged
C
DiscoveryResultSSDP
E
addressChanged
E
lastSeenChanged
C
DiscoveryStrategy
F
getDiscoveryResult
F
getDiscoveryResults
E
result
C
Driver
F
getDevice
F
getDevices
F
getDiscoveryStrategy
F
getManifest
F
onInit
F
onMapDeviceClass
F
onPair
F
onPairListDevices
F
onRepair
F
ready
C
FlowArgument
F
registerAutocompleteListener
C
FlowCard
F
getArgument
F
getArgumentValues
F
register
F
registerRunListener
F
unregister
E
update
C
FlowCardAction
F
getArgument
F
getArgumentValues
F
register
F
registerRunListener
F
unregister
E
update
C
FlowCardCondition
F
getArgument
F
getArgumentValues
F
register
F
registerRunListener
F
unregister
E
update
C
FlowCardTrigger
F
getArgument
F
getArgumentValues
F
register
F
registerRunListener
F
trigger
F
unregister
E
update
C
FlowCardTriggerDevice
F
getArgument
F
getArgumentValues
F
register
F
registerRunListener
F
trigger
F
unregister
E
update
C
FlowToken
F
register
F
setValue
F
unregister
C
HomeyClient
F
emit
F
registerBroadcastListener
F
registerRequestListener
C
Image
F
getBuffer
F
getFormat
F
getStream
F
pipe
F
register
F
setBuffer
F
setPath
F
setStream
F
setUrl
F
unregister
F
update
C
InsightsLog
F
createEntry
C
LedringAnimation
F
register
F
registerScreensaver
F
start
F
stop
F
unregister
F
unregisterScreensaver
F
updateFrames
E
finish
E
start
E
stop
C
LedringAnimationSystem
F
register
F
registerScreensaver
F
start
F
stop
F
unregister
F
unregisterScreensaver
F
updateFrames
E
finish
E
start
E
stop
C
LedringAnimationSystemProgress
F
register
F
registerScreensaver
F
setProgress
F
start
F
stop
F
unregister
F
unregisterScreensaver
F
updateFrames
E
finish
E
start
E
stop
C
Notification
F
register
C
Signal
F
cmd
F
register
F
tx
F
unregister
C
Signal433
F
cmd
F
register
F
tx
F
unregister
C
Signal868
F
cmd
F
register
F
tx
F
unregister
C
SignalInfrared
F
cmd
F
register
F
tx
F
unregister
C
SimpleClass
F
error
F
log
C
ZigBeeNode
C
ZwaveCommandClass
E
report
C
ZwaveNode
E
nif
E
online
E
unknownReport
Managers
M
ManagerApi
F
delete
F
get
F
getApi
F
getLocalUrl
F
getOwnerApiToken
F
post
F
put
F
realtime
F
registerApi
F
unregisterApi
M
ManagerApps
F
getInstalled
F
getVersion
M
ManagerArp
F
getMAC
M
ManagerAudio
F
playMp3
F
playWav
F
removeMp3
F
removeWav
M
ManagerBLE
F
discover
F
find
M
ManagerClock
F
getTimezone
E
timezoneChange
M
ManagerCloud
F
generateOAuth2Callback
F
getHomeyId
F
getLocalAddress
F
registerWebhook
F
unregisterWebhook
M
ManagerCron
F
getTask
F
getTasks
F
registerTask
F
unregisterAllTasks
F
unregisterTask
M
ManagerDiscovery
F
getDiscoveryStrategy
M
ManagerDrivers
F
getDriver
F
getDrivers
M
ManagerFlow
F
getCard
F
registerCard
F
registerToken
F
unregisterCard
F
unregisterToken
M
ManagerGeolocation
F
getAccuracy
F
getLatitude
F
getLongitude
F
getMode
E
location
M
ManagerI18n
F
__
F
getLanguage
F
getUnits
M
ManagerImages
F
getImage
F
registerImage
F
unregisterImage
M
ManagerInsights
F
createLog
F
deleteLog
F
getLog
F
getLogs
M
ManagerLedring
F
registerAnimation
F
registerScreensaver
F
unregisterAnimation
F
unregisterScreensaver
M
ManagerNFC
E
tag
M
ManagerNotifications
F
registerNotification
M
ManagerRF
F
registerSignal
F
unregisterSignal
M
ManagerSettings
F
get
F
getKeys
F
set
F
unset
E
set
E
unset
M
ManagerSpeechOutput
F
say
M
ManagerZigBee
F
getNode
M
ManagerZwave
F
getNode
Done
"template": "done"
This view will automatically close the pair session.